Skip to main content

Glossary

Client ID​

An opaque identifier your app generates per end user. Sent on all requests as clientId. The clientId should be consistent for a single user across multiple devices and multiple sessions.

Token / Secret​

Static credentials used to obtain a short-lived bearer token via POST /v2/authenticate (v1: POST /authenticate). You can obtain your credentials in the Clips Studio.

Bearer Token​

Short-lived credential returned by the authenticate endpoint and sent in the Authorization: Bearer <token> header for all other API calls.

Collection​

A curated grouping of clips. Returned by GET /v2/collections and GET /v2/collections/{id} (v1: POST /collections and POST /collection).

Track​

A full-length audio file (e.g., MP4 320k). Retrieved by GET /v2/tracks/{id} (v1: POST /track-fetch) for preview or clipping.

Clip​

A select section of a track (up to 60s in length).

Curated Clip​

A curated segment of a track, selected by Feed's curators and provided by default.

Custom Clip​

A user-generated clip (up to 60s in length) created via the POST /v2/clips endpoint shared (v1: POST /clip) endpoint.

Explicitness​

Metadata that indicates whether or not a song contains profane lyrics, or if profanity has been edited out of a song.

Rating​

Metadata that classifies age-appropriate content based on words and lyrical themes (i.e., sex, drugs, and/or violence).

Format​

Audio encoding and bitrate. The API formats these as a single string value comprised of {encoding}:{bitrate}, e.g., aac:128, mp3:128, mp4:320.

Play Method​

When reporting a play, you provide a method that describes how the content is used:

  • Stream — it is being streamed directly from our system.
  • Offline — it was previously streamed, and is now being reported retroactively. A timestamp must be included.
  • Sync — it was played in a piece of video or otherwise moving picture content.

In v2 the play endpoint is POST /v2/clips/{id}/play; in v1 it was POST /play.

ISRC​

International Standard Recording Code identifying a specific recording.

Failure Code​

A machine-readable error code indicating why a request or item failed. See The Response and Error Model for the full list and semantics.

Error Data​

Optional structured context returned with an error to aid debugging (errorData).